readme: document all environment options
authorPaul Donald <[email protected]>
Tue, 4 Nov 2025 00:16:27 +0000 (01:16 +0100)
committerÁlvaro Fernández Rojas <[email protected]>
Tue, 4 Nov 2025 15:24:51 +0000 (16:24 +0100)
These options were previously undocumented.
Document also an OPTION_x example.

Signed-off-by: Paul Donald <[email protected]>
Link: https://github.com/openwrt/odhcp6c/pull/111
Signed-off-by: Álvaro Fernández Rojas <[email protected]>
README.md

index a12dff7953db12c49754c39d86c4374e513e35f6..a99990d070cfbd9c8ea08aa715bc77306e095acb 100644 (file)
--- a/README.md
+++ b/README.md
@@ -65,6 +65,7 @@ The script is called with the following parameters: `<interface>` `<state>`
 
 | Environment                                          | Description                                                                                                           |
 |-----------------------------------|-------------------------------------------------------------------|
+| `SERVER`                                                     | A space-separated list of upstream IPv6 routers                                       |
 | `RDNSS`                                                      | A space-separated list of recursive DNS servers                                       |
 | `DOMAINS`                                                    | A space-separated list of DNS search domains                                          |
 | `SNTP_IP`                                                    | A space-separated list of SNTP server IP addresses                            |
@@ -72,6 +73,7 @@ The script is called with the following parameters: `<interface>` `<state>`
 | `SIP_IP`                                                     | A space-separated list of SIP servers                                                         |
 | `SIP_DOMAIN`                                         | A space-separated list of SIP domains                                                         |
 | `OPTION_<num>`                                       | Custom option received as base-16                                                                     |
+|                                                                      | E.g. (Client ID) `OPTION_1` : `000300010badf00dcafe`                          |
 | `PREFIXES`                                           | A space-separated list of prefixes currently assigned                         |
 |                                                                      |       Format: `<prefix>/<length>,preferred,valid[,excluded=<excluded-prefix>/<length>][,class=<prefix class #>]`|
 | `ADDRESSES`                                          | A space-separated list of addresses currently assigned                        |
@@ -87,7 +89,9 @@ The script is called with the following parameters: `<interface>` `<state>`
 | `RA_REACHABLE`                                       | ND Reachability time                                                                                          |
 | `RA_RETRANSMIT`                                      | ND Retransmit time                                                                                            |
 | `AFTR`                                                       | The DS-Lite AFTR domain name                                                                          |
+| `CER`                                                                | A space-separated list of CER-id IPv6                                                         |
 | `MAPE` / `MAPT` / `LW4O6`            | Softwire rules for MAPE, MAPT and LW4O6                                                       |
+| `PASSTHRU`                                           | The content of the last packet relayed                                                        |